Documentation In "Doc" Files
First remember how to point Docular at your doc files. Next, understand the main differences between script files and "doc" files.
The first obvious difference is that these files must end with a ".doc" file extension. This allows you to mix your ".doc" files with script files within the same directory and have Docular pick them out easily.
The most important difference is that "doc" files contain no code and are meant exclusively for storing documentation. This means documentation does not need to reside within comment blocks.
"Doc" files are perfect for storing "overview" type documentation, tutorials, and introductions. Most of the documentation you are reading here was made within "doc" files.
When "Doc" files are read, the parser looks for a document identifier. This signals the begginning of a documentation section. All other documentation fields that are encountered are parsed and attached to this documentation object.
This process continues until the end of the file is reached or until a new document identifier is discovered. At this point either the process ends or the start of a new documentation object begins.
Here is an example of Docular documentation within a "doc" file:
@doc overview @id intro @name Intro To My Code @description #Welcome to My Code ## Why My Code is Awesome 1. Naming is clear 2. It is well organized 3. It is well documented ;-)
So here are a few points to note: